Модели данных
SDK предоставляет модели для всех типов ассетов. Основной тип для большинства интеграций -- CollectionHost.
CollectionHost
Хост (сервер, рабочая станция, сетевое устройство).
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
name | str | да | Уникальное имя хоста (hostname, FQDN) |
responsible | str | да | UUID ответственного пользователя |
display_name | str | нет | Отображаемое имя |
operation_system | str | нет | Операционная система |
net_interfaces | List[NetInterfaces] | нет | Сетевые интерфейсы |
packages | List[Package] | нет | Установленное ПО |
network_services | List[NetworkService] | нет | Сетевые сервисы (открытые порты) |
zone_id | str | нет | ID зоны |
tenant_id | str (UUID) | нет | ID тенанта |
metadata | Dict[str, object] | нет | Произвольные данные, не входящие в стандартную схему |
NetInterfaces
Сетевой интерфейс хоста.
| Поле | Тип | Описание |
|---|---|---|
name | str | Имя интерфейса (eth0, ens192) |
ipv4 | str | IPv4 адрес |
ipv6 | str | IPv6 адрес |
mac_addr | str | MAC-адрес |
fqdn | str | FQDN |
network_id | str | ID связанной сети |
Package
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
name | str | да | Название пакета |
version | str | да | Версия |
architecture | str | нет | Архитектура (x86_64, arm64) |
vendor | str | нет | Поставщик |
os | str | нет | ОС, для которой пакет |
description | str | нет | Описание |
repository | str | нет | Репозиторий |
CollectionAccount
Учетная запись.
| Поле | Тип | Описание |
|---|---|---|
username | str | Логин |
fio | str | ФИО |
mail | str | |
tenant_id | str (UUID) | ID тенанта |
external_system_id | str | ID во внешней системе |
last_time_loaded | str | Дата последней загрузки |
externally_blocked | bool | Заблокирован ли во внешней системе |
metadata | Dict[str, object] | Произвольные данные |
CollectionNetwork
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
name | str | да | Название сети |
zone_id | str (UUID) | да | ID зоны |
type | str | да | Тип сети |
cidr | str | нет | CIDR, например 192.168.1.0/24 |
description | str | нет | Описание |
metadata | Dict[str, object] | нет | Произвольные данные |
CollectionExternalAddress
| Поле | Тип | Обязательное | Описание |
|---|---|---|---|
type_ext_address | str | да | Тип: fqdn или ip |
type_value | str | да | Значение: IP-адрес или доменное имя |
description | str | нет | Описание |
network_services | List[NetworkService] | нет | Связанные сетевые сервисы |
metadata | Dict[str, object] | нет | Произвольные данные |
Metadata
Поле metadata (тип Dict[str, object]) доступно во всех моделях ассетов. Используйте его для хранения любых данных из внешней системы, которые не вписываются в стандартную схему:
host = CollectionHost(
name="server-01",
responsible="00000000-0000-0000-0000-000000000000",
metadata={
"external_id": "jport-12345",
"location": "DC-1, Rack 42",
"criticality": "high",
"last_scan_date": "2025-01-15T10:30:00Z"
}
)